/*
 * Modified MIT License
 * 
 * Copyright (c) 2006-2007 Houdah Software s.à r.l.
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * Except as contained in this notice, the name(s) of the above copyright holders
 * shall not be used in advertising or otherwise to promote the sale, use or other 
 * dealings in this Software without prior written authorization.
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
**/

package com.houdah.appserver.support;

/**
 * Custom runtime exception. <br/>
 * 
 * @author bernard
 */
public class ApplicationException extends RuntimeException
{
	// Private class constants
	
	private static final long	serialVersionUID	= -358020698201247917L;
	
	
	
	// Public class constants
	
	/**
	 * Useful constant for severity.
	 */
	public static final int		COMPONENT_ALIVE		= 0;
	
	
	
	/**
	 * Useful constant for severity.
	 */
	public static final int		SESSION_ALIVE		= 1;
	
	
	
	/**
	 * Useful constant for severity.
	 */
	public static final int		APPLICATION_ALIVE	= 2;
	
	
	
	// Private instance variables
	
	private int					severity;
	
	
	
	
	// Constructor
	
	/**
	 * Designated onstructor. <br/>
	 * 
	 * @param message
	 *            a descriptive error message
	 * @param cause
	 *            another exception
	 * @param severity
	 *            the severity of the encountered problem
	 * @see COMPONENT_ALIVE
	 * @see SESSION_ALIVE
	 * @see APPLICATION_ALIVE
	 */
	public ApplicationException(String message, Throwable cause, int severity)
	{
		super(message, cause);
		
		this.severity = severity;
	}
	
	
	
	/**
	 * Constructor. <br/>
	 * 
	 * @param cause
	 *            another exception
	 * @param severity
	 *            the severity of the encountered problem
	 * @see COMPONENT_ALIVE
	 * @see SESSION_ALIVE
	 * @see APPLICATION_ALIVE
	 */
	public ApplicationException(Throwable cause, int severity)
	{
		this(null, cause, severity);
	}
	
	/**
	 * Constructor. <br/>
	 * 
	 * @param message
	 *            a descriptive error message
	 * @param severity
	 *            the severity of the encountered problem
	 * @see COMPONENT_ALIVE
	 * @see SESSION_ALIVE
	 * @see APPLICATION_ALIVE
	 */
	public ApplicationException(String message, int severity)
	{
		this(message, null, severity);
	}
	
	/**
	 * Constructor. <br/>
	 * 
	 * @param severity
	 *            the severity of the encountered problem
	 * @see COMPONENT_ALIVE
	 * @see SESSION_ALIVE
	 * @see APPLICATION_ALIVE
	 */
	public ApplicationException(int severity)
	{
		this(null, null, severity);
	}
	
	
	
	// Public instance methods
	
	/**
	 * Gets the severity of the problem that triggered the exception. <br/>
	 * 
	 * Depending on the severity the UI may suggest the user to
	 * <ul>
	 * <li>backtrack and correct submitted information
	 * <li>return to a known safe entry point
	 * <li>open a new session
	 * </ul>
	 * 
	 * @return the severity of the encountered problem
	 * @see COMPONENT_ALIVE
	 * @see SESSION_ALIVE
	 * @see APPLICATION_ALIVE
	 */
	public int severity()
	{
		return severity;
	}
	
	
	
	/**
	 * Get a String representation.
	 * 
	 * @return a String represe
	 */
	public String toString()
	{
		return super.toString() + "\nseverity: " + severity;
	}
}